Please enable JavaScript to view this website.

Skip to main content

Map Fields

Required Fields

Column NameDescriptionData TypeRequired
LABELA description of the data contained at the memory map addressStringYes
HEX_ADDRESSMemory Address of where to start reading dataHEX StringYes
FIELD_SIZEHow many bytes of data to readIntegerYes
PRODUCT_INTERNAL_SUBSYSTEM_IDFor products with subsystems, this id specifies a specific subsystem to read fromIntegerNo

Parsing Information

Column NameDescriptionData TypeDefault Value
PARAMETERMX Only – used in combination with hex address to identify a unique object/memory location/whatever you want to call it.String
IS_PARSEDShould this field be read or parsed by client applicationsBooleanFalse
PARSE_TYPE_IDHow the data should be parsed by client applicationsInteger corresponding to a Parse Type
PARSED_DATA_LABELSLabels if data is displayed as a chart or tableString
IS_BINARYConvert the HEX string to binary instead of an integerBooleanFalse
IS_BYTE_SWAPPEDByte swap this field before parsing to integer or binary valueBooleanFalse
IS_FINAL_EVENT_STATEUsed with MX Events. Flags a histogram as being the final state for a given set of fault codes.BooleanFalse
MODULE_IDUsed with MX Events. A reference to the module for which to match an enum to a predetermined list of possible fault codes.String
PRODUCTThe product ID which this memory map is associated with. This field is read only and cannot be editted.Integer
IS_PCBA_PART_NUMBERShould the value of this field be used to match with an item in the BATTERY_PCBA_TABLE (M18 Packs Only)BooleanFalse
SCALE_VALUEIf set, the value read from the tool (parsed as an int) will be divided by the scale valueInteger1
ENUMERATION_DICTIONARY_UUIDIf the parsed value is a key in a key/value pair, this UUID identifies the correct dictionary to do the lookupString
COMPARATOR_VALUEIf the parsed value is a key in a key/value pair, this is the value to compare against to determine if the key is valid.Integer
BYTE_SWAP_WORD_LENGTHThe number of bytes to swap in a word. For example, if the value is 2, the bytes will be swapped in 2 byte pairs. If the value is 4, the bytes will be swapped in groups of 4 bytes.Integer1
MX_TOOL_SEGMENT_COUNTMX Only – The number of segments in the tool.Integer1
PARSE_OFFSET_ADDRESSThe offset address, in HEX, relative to the UCB data field which this field begins. For example, if the UCB data begins at address 0x0015, and this is the first subfield within it, the value of this property would be 0x0000. For use with UCB Parse Type ID 26HEX
PARSE_SEGMENT_LENGTHThe length as a HEX value of this segment of the UCB data. For example, a ten byte length field would have a value of 000A. For use with UCB Parse Type ID 26HEX
PARENT_FIELDThe HEX address of the parent UCB field which this field belongs to. For use with UCB Parse Type ID 26HEX
CAN_NODEIDThe ID of the node, as a hex value, to target this field to. For use with CAN Open router.HEX
CAN_INDEXThe index, as a hex value, on the given node this data field resides.HEX
CAN_SUBINDEXThe subindex, as a hex value, on the given node and index this data field resides.HEX
PARSED_DATA_SUB_LABELSSub-Labels that are used for Multidimensional Datasets Parse Type ID 33.String
NUMBER_CONFIGUsed for defining the Q Notation for Fixed Point Parse Type ID 34. Format is M.N. Sample values: 3.4, 7.8, 15.16String
SIGNEDIf set, the value will be interpreted as a signed integer.BooleanFalse

Notes

  1. For CANOpen tools which use the UCB parse type, the CAN specific fields are required on the child fields and should match the parent values.

Source Types

A list of source types as used when uploading tool data via APIs.

IDName
1okat-diagnostics-ios-app
2one-key-ios-app
3one-key-android-app
4qbot
5reliability-engineering-test-lab
7unknown
8service
930 day
10warranty
11cell balance
12cpf lab
13one-key-service-app
14field-reporter
15sentinel-field
16Battery Service Tester
17QuickLink
18QuickLink Web
19cellular_tool_communications